Skip to content

feat: Use openedx_catalog app, backfill its CourseRuns [FC-0117]#38023

Open
bradenmacdonald wants to merge 12 commits intoopenedx:masterfrom
open-craft:braden/openedx-catalog
Open

feat: Use openedx_catalog app, backfill its CourseRuns [FC-0117]#38023
bradenmacdonald wants to merge 12 commits intoopenedx:masterfrom
open-craft:braden/openedx-catalog

Conversation

@bradenmacdonald
Copy link
Contributor

@bradenmacdonald bradenmacdonald commented Feb 19, 2026

Description

This is the openedx-platform companion PR to openedx/openedx-core#479 . Please see that PR for more information.

@bradenmacdonald bradenmacdonald added the FC Relates to an Axim Funded Contribution project label Feb 19, 2026
@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Feb 19, 2026
@openedx-webhooks
Copy link

openedx-webhooks commented Feb 19, 2026 •
edited
Loading

Thanks for the pull request, @bradenmacdonald!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@openedx-webhooks
Copy link

openedx-webhooks commented Feb 19, 2026

Thanks for the pull request, @bradenmacdonald!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Feb 19, 2026
@bradenmacdonald bradenmacdonald mentioned this pull request Feb 19, 2026
Open
6 tasks
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Feb 24, 2026
@bradenmacdonald bradenmacdonald marked this pull request as ready for review February 27, 2026 01:05
kdmccormick
kdmccormick reviewed Mar 2, 2026
View reviewed changes
Copy link
Member

@kdmccormick kdmccormick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(still reviewing)

.../core/djangoapps/content/course_overviews/migrations/0030_backfill_new_catalog_courseruns.py
and course_overview.display_name != cc.display_name
and cc.display_name != course_code
):
# The runs have different names, so just use the course code as the common catalog course name.
Copy link
Member

@kdmccormick kdmccormick Mar 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My instinct here would be to backfill using the latest CourseRun's title rather than the course code. My thinking is this: in our new model, the CatalogCourse title represents the "default" CourseRun title, i.e. the CatalogCourse title is used when no CourseRun is specified. Thus, the CatalogCourse title should be backfilled to something that an instructor would actually want to use as the title when they're re-running the course, and I think that would be the latest CourseRun's title rather than the course code.

But, that assumes that course authors typically do not reflect the run into their course title (e.g., "Physics 101 - Spring 2027"), which I think is a safe assumption, but I could be wrong. What do you think @ormsbee @bradenmacdonald ?

Copy link
Contributor Author

@bradenmacdonald bradenmacdonald Mar 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But, that assumes that course authors typically do not reflect the run into their course title (e.g., "Physics 101 - Spring 2027"), which I think is a safe assumption, but I could be wrong. What do you think @ormsbee @bradenmacdonald ?

I was actually thinking the opposite here, that authors sometimes do incorporate the run into their title in exactly that manner, because I'm pretty sure I've seen that, on instances which have lots of very similar runs (e.g. CCX use case with dozens of identical CCX variants of a course). But I just checked a few real instances and didn't see any examples of this, so maybe it's uncommon enough that we should just use the title as the default.

@kdmccormick kdmccormick self-requested a review March 2, 2026 17:57
bradenmacdonald
bradenmacdonald commented Mar 2, 2026
View reviewed changes
openedx/core/djangoapps/content/course_overviews/tests/test_sync_with_openedx_catalog.py
Comment on lines +7 to +8
from openedx_catalog import api as catalog_api
from openedx_catalog.models_api import CatalogCourse, CourseRun
Copy link
Contributor Author

@bradenmacdonald bradenmacdonald Mar 2, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm following our existing convention here, but it seems a tiny bit annoying to import some things from models_api and everything else from api when it's all part of the public API.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kdmccormick kdmccormick Awaiting requested review from kdmccormick

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U

Projects

Contributions
Status: Waiting on Author

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@bradenmacdonald @openedx-webhooks @kdmccormick